DSTU2 QA Preview

This page is part of the FHIR Specification (v1.0.0: DSTU 2 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension: Describes a required data item

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/cqif-basic-data

Status: draft. Extension maintained by: Health Level Seven, Inc. - CDS WG

Describes a required data item for evaluation in terms of the type of data, and optional code- or date-based filters of the data.

Context of Use: Use on element: Basic

usage info: insert a list of places where this extension is used

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/cqif-basic-data
Describes a required data item: Describes a required data item for evaluation in terms of the type of data, and optional code- or date-based filters of the data.
Use on element: Basic
... type1..1codeThe type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
... profile0..1Reference(StructureDefinition)The profile of the required data, specified as the uri of the profile definition.
... mustSupport0..*stringIndicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

doco Documentation for this format

Fulle Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/cqif-basic-data
Describes a required data item: Describes a required data item for evaluation in terms of the type of data, and optional code- or date-based filters of the data.
Use on element: Basic
... extension 1..1ExtensionThe type of the required data
.... extension 0..0
.... url 1..1uri"type"
.... valueCode 1..1codeValue of extension
Binding: Parameter Types used in Operation Definitions (required)
... extension 0..1ExtensionThe profile of the required data
.... extension 0..0
.... url 1..1uri"profile"
.... valueReference 1..1Reference(StructureDefinition)Value of extension
... extension 0..*ExtensionIndicates that specific structure elements are referenced by the knowledge module
.... extension 0..0
.... url 1..1uri"mustSupport"
.... valueString 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqif-basic-data"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- Describes a required data item -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/cqif-basic-data" >
 <-- extension sliced by url  in any order-->
 <extension url="type"> 1..1 Extension  <!-- 1..1 The type of the required data -->
  <valueCode value="[code]"/><!-- 1..1 Value of extension -->
 </extension>
 <extension url="profile"> 0..1 Extension  <!-- 0..1 The profile of the required data -->
  <valueReference><!-- 1..1 Reference(StructureDefinition) 
      Value of extension -->
 </extension>
 <extension url="mustSupport"> 0..* Extension  <!-- 0..* Indicates that specific structure elements are referenced by the knowledge module -->
  <valueString value="[string]"/><!-- 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // Describes a required data item
    "extension" : [ //  sliced by url  in any order
      { // The type of the required data // R! 
        // from Element: extension
        "url" : "type", // R! 
        "valueCode" : "<code>" // R! Value of extension
      },
      { // The profile of the required data //
        // from Element: extension
        "url" : "profile", // R! 
        "valueReference" : { Reference(StructureDefinition) } // R! Value of extension
      },
      { // Indicates that specific structure elements are referenced by the knowledge module //
        // from Element: extension
        "url" : "mustSupport", // R! 
        "valueString" : "<string>" // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/cqif-basic-data", // R! 
// value[x]: Value of extension. One of these 33:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/cqif-basic-data
Describes a required data item: Describes a required data item for evaluation in terms of the type of data, and optional code- or date-based filters of the data.
Use on element: Basic
... type1..1codeThe type of the required data, specified as the type name of a resource. For profiles, this value is set to the type of the base resource of the profile.
... profile0..1Reference(StructureDefinition)The profile of the required data, specified as the uri of the profile definition.
... mustSupport0..*stringIndicates that specific elements of the type are referenced by the knowledge module and must be supported by the consumer in order to obtain an effective evaluation. This does not mean that a value is required for this element, only that the consuming system must understand the element and be able to provide values for it if they are available.

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/cqif-basic-data
Describes a required data item: Describes a required data item for evaluation in terms of the type of data, and optional code- or date-based filters of the data.
Use on element: Basic
... extension 1..1ExtensionThe type of the required data
.... extension 0..0
.... url 1..1uri"type"
.... valueCode 1..1codeValue of extension
Binding: Parameter Types used in Operation Definitions (required)
... extension 0..1ExtensionThe profile of the required data
.... extension 0..0
.... url 1..1uri"profile"
.... valueReference 1..1Reference(StructureDefinition)Value of extension
... extension 0..*ExtensionIndicates that specific structure elements are referenced by the knowledge module
.... extension 0..0
.... url 1..1uri"mustSupport"
.... valueString 1..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/cqif-basic-data"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- Describes a required data item -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/cqif-basic-data" >
 <-- extension sliced by url  in any order-->
 <extension url="type"> 1..1 Extension  <!-- 1..1 The type of the required data -->
  <valueCode value="[code]"/><!-- 1..1 Value of extension -->
 </extension>
 <extension url="profile"> 0..1 Extension  <!-- 0..1 The profile of the required data -->
  <valueReference><!-- 1..1 Reference(StructureDefinition) 
      Value of extension -->
 </extension>
 <extension url="mustSupport"> 0..* Extension  <!-- 0..* Indicates that specific structure elements are referenced by the knowledge module -->
  <valueString value="[string]"/><!-- 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // Describes a required data item
    "extension" : [ //  sliced by url  in any order
      { // The type of the required data // R! 
        // from Element: extension
        "url" : "type", // R! 
        "valueCode" : "<code>" // R! Value of extension
      },
      { // The profile of the required data //
        // from Element: extension
        "url" : "profile", // R! 
        "valueReference" : { Reference(StructureDefinition) } // R! Value of extension
      },
      { // Indicates that specific structure elements are referenced by the knowledge module //
        // from Element: extension
        "url" : "mustSupport", // R! 
        "valueString" : "<string>" // R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/cqif-basic-data", // R! 
// value[x]: Value of extension. One of these 33:
  }